Skip to content

Conversation

@Mpdreamz
Copy link
Member

@Mpdreamz Mpdreamz commented Oct 1, 2025

  • Document all CLI commands on docs-builder.
  • Document basic building blocks that define docs-builder's architecture.
    • Documentation Set
    • Assembler Builds
    • Navigation, docset.yml, toc.yml, navigation.yml and how they all relate
    • Linking, inbound and outbound link validation
    • Distributed documentaton
    • Link Service, Link Catalog and Link Index files. (cc @elastic/docs-engineering for updated terminology).

@Mpdreamz Mpdreamz requested a review from a team as a code owner October 1, 2025 11:02
@Mpdreamz Mpdreamz added the documentation Improvements or additions to documentation label Oct 1, 2025
@Mpdreamz Mpdreamz requested a review from a team as a code owner October 1, 2025 11:02
@Mpdreamz Mpdreamz self-assigned this Oct 1, 2025
@Mpdreamz Mpdreamz requested a review from cotti October 1, 2025 11:02
@Mpdreamz Mpdreamz changed the title feature/cli documentation Add more documentation for docs-builder CLI and its basic building blocks Oct 1, 2025
Copy link
Member

@reakaleek reakaleek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow! This looks nice on the first look. 🚀

Need some time to read through it.

Copy link
Contributor

@theletterf theletterf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great. Just formatting nits that you can apply to all docs.

@github-actions
Copy link

github-actions bot commented Oct 1, 2025

🔍 Preview links for changed docs

More links …

@Mpdreamz Mpdreamz requested a review from reakaleek October 1, 2025 15:24
@Mpdreamz Mpdreamz merged commit e277841 into main Oct 2, 2025
21 checks passed
@Mpdreamz Mpdreamz deleted the feature/cli-documentation branch October 2, 2025 13:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants